home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Source Code / Visual Basic Source Code.iso / vbsource / hm510 / readme.txt < prev    next >
Text File  |  1998-11-23  |  6KB  |  172 lines
  1. Header Maker for Visual Basic 5.0, version 1.0
  2.  
  3. This Visual Basic 5.0 add-in allows the programmer to
  4. use his own predefined header for all of its code
  5. procedures.
  6.  
  7. You can defined as many templates you wish that wil allow
  8. you to include such as the programmer's name, the creation
  9. date of the procedure or your error trapping section. YOU
  10. will decide the way your code procedure will looks like and
  11. YOU will define your own coding stantards. With Header Maker,
  12. all of your programmers will write there code procedure the
  13. same way.
  14.  
  15. _______________________________________________________________
  16.  
  17. Contents:
  18.  
  19. 1- Installation
  20. 2- How to use it
  21. 3- Registration
  22. 4- Disclaimer
  23.  
  24. _______________________________________________________________
  25.  
  26. 1- Installation
  27. ---------------
  28.  
  29.    - Double-click on the file HM510.EXE. This will cause it
  30.      to de-compress itself.
  31.  
  32.      *******************************************************
  33.      *                                                     *
  34.      *    CAUTION!  Make sure that you are running this    *
  35.      *    .EXE file in an empty folder or on a blank       *
  36.      *    formatted diskette!                              *
  37.      *                                                     *
  38.      *******************************************************
  39.  
  40.    - Double-click the "SETUP.EXE" Setup File. This will install 
  41.      the add-in.
  42.  
  43.    - Once you have installed this utility, you can delete the files 
  44.      from the folder that HM510.EXE was run.
  45.  
  46.    - In Visual Basic 5.0, open the [Add-Ins] menu and select
  47.      [Add-In Manager...]. Check ½Header Maker╗. You now
  48.      have a ½Header Maker╗ menu under the pop-up menu from your 
  49.      code window.
  50.  
  51.    - If you need to uninstall this utility, open the Control Panel, 
  52.      and double-click "Add/Remove Software."
  53.  
  54. _______________________________________________________________
  55.  
  56. 2- How to use it
  57. -----------------
  58.  
  59. There are three menus under the ½Header Maker╗ menu:
  60.  
  61. [Insert header]: To insert your personalized header in your
  62.                  module, right-click anywhere in the procedure
  63.                  where you want to add a header, i.e. between the
  64.                  ½Sub MySub ()╗ line and the ½End Sub╗ line. Select
  65.                  [Header Maker], [Insert header]. Your personalized
  66.                  header wil be inserted in your procedure.
  67.  
  68.                  If you already have some code in your procedure,
  69.                  it will be placed at the end of your procedure,
  70.                  before the ½End Sub╗ line.
  71.  
  72.                  A template is included with this copy of Header Maker
  73.                  (½Header Demo.hmt╗ file). You can take a look at it
  74.                  and transform it for your own templates.
  75.  
  76.  
  77. [Options]:       This menu shows a form in which you can define
  78.                  your Header Maker Templates names and paths. You
  79.                  can defined your own tags and write as many
  80.                  template you wish:
  81.  
  82.   Name:             A descriptive name for the template that will
  83.                     be used.
  84.  
  85.   Path:             The path to the template file (.hmt).
  86.  
  87.   Remove:           To remove the current template from the
  88.                     list.
  89.  
  90.   Language:         Header Maker can be in french or in english.
  91.                     
  92.   Procedure's name: The tag used in your template
  93.                     file (.hmt) for the name of the procedure. Supposed
  94.                     that the tag ½Proc╗ is used for inserting a header
  95.                     in the Form_Load event, the following lines in the
  96.                     template file:
  97.  
  98.                     On Error Goto Err_½Proc╗
  99.                     Exit_½Proc╗:
  100.                     Err_½Proc╗:
  101.                     
  102.                     will produce:
  103.                     
  104.                     On Error Goto Err_From_Load
  105.                     Exit_Form_Load:
  106.                     Err_Form_Load:
  107.                     
  108.   Procedure's type: The tag used in your template file (.hmt) for the
  109.                     type of the procedure. Supposed that the tag
  110.                     ½Type╗ is used for inserting a header in a
  111.                     TestIt function, the following lines in the
  112.                     template file:
  113.  
  114.                     Exit ½Type╗
  115.                     
  116.                     will produce:
  117.                     
  118.                     Exit Function
  119.                     
  120.   Programmer:       The tags used in your template file (.hmt) for the
  121.       &             name of the programmer. If you use the ½Prog╗ tag
  122. Programmer's name:  in your template and John Smith as the programmer's
  123.                     name:
  124.  
  125.                     'Created By: ½Prog╗
  126.  
  127.                     will produce:
  128.  
  129.                     'Created By: John Smith
  130.  
  131.      Date:          The tags used in your template file (.hmt) for the
  132.       &             current date. Can be any of the recognized date format
  133.   Date Format:      including ½Short Date╗ and ½Long Date╗. If you use the
  134.                     ½Date╗ tag in your template and define ½dd mmmm yy╗ as
  135.                     the date format:
  136.  
  137.                     'Created On: ½Date╗
  138.  
  139.                     will produce:
  140.  
  141.                     'Created On: 12 August 97
  142.  
  143.  
  144. [About Header Maker]:This menu shows the About form. There is a 10
  145.                      seconds countdown on the unregistered version.
  146.                      This countdown is also displayed each time you
  147.                      connect, disconnect or insert a header. There is
  148.                      no more countdowns when you registered.
  149.  
  150.                     
  151. _______________________________________________________________
  152.  
  153. 3- Registration
  154. ---------------
  155.  
  156. To register, print the form located in the Reg-en.txt file and send it
  157. at the address indicated with a cheque or postal money order. Indicate
  158. the way you would like to receive your registration number. Once you
  159. you have receive it, got to the menu [Header Maker], [About Header
  160. Maker] and click on the Registration command button.
  161.  
  162.  
  163. _______________________________________________________________
  164.  
  165. 4- Disclaimer
  166. ---------------
  167.  
  168. You use this at your own risk. While all attempts have been made to
  169. make this software error free, Soft concepts is in no way liable for
  170. any losses due to the use of this software. No warranty is given
  171. or implied.
  172.